Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move array documentation out of HelpDB, add examples #17795

Merged
merged 3 commits into from
Aug 4, 2016
Merged

Conversation

kshyatt
Copy link
Contributor

@kshyatt kshyatt commented Aug 3, 2016

Lots of examples for things that are probably confusing for new
Julia users. Made reducedim and mapreducedim arguments more
similar to the ones for reduce and mapreduce.

Lots of examples for things that are probably confusing for new
Julia users. Made `reducedim` and `mapreducedim` arguments more
similar to the ones for `reduce` and `mapreduce`.
@kshyatt kshyatt added docs This change adds or pertains to documentation arrays [a, r, r, a, y, s] labels Aug 3, 2016

.. Docstring generated from Julia source

Cumulative product along a dimension ``dim`` (defaults to 1). See also :func:`cumprod!` to use a preallocated output array, both for performance and to control the precision of the output (e.g. to avoid overflow).

.. doctest::

julia> a = rand(1:8,3,4)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not good to put rand in doctests

@kshyatt
Copy link
Contributor Author

kshyatt commented Aug 4, 2016

Doctests passed and no one has complained about the content of this PR, so I'm going to squash & merge.

@kshyatt kshyatt merged commit 3e00217 into master Aug 4, 2016
@kshyatt kshyatt deleted the ksh/docarray branch August 4, 2016 23:55
tkelman pushed a commit that referenced this pull request Aug 11, 2016
Lots of examples for things that are probably confusing for new
Julia users. Made `reducedim` and `mapreducedim` arguments more
similar to the ones for `reduce` and `mapreduce`.
(cherry picked from commit 3e00217)
mfasi pushed a commit to mfasi/julia that referenced this pull request Sep 5, 2016
Lots of examples for things that are probably confusing for new
Julia users. Made `reducedim` and `mapreducedim` arguments more
similar to the ones for `reduce` and `mapreduce`.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
arrays [a, r, r, a, y, s] docs This change adds or pertains to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants